Groups

Updates the group description

Update the description text for the group.

PUT
https://api.wawp.net/v2/groups/{id}/description?access_token=123456789&description=This+group+is+for+discussing+the+new+project+features.&id=1234567890%40g.us&instance_id=123456789

Authentication Required

Login to swap the placeholders with your real Instance ID and Access Token.

Log In
Test /v2/groups/{id}/description endpoint
PUT
PUT

No query parameters required

This endpoint doesn't expect data in the URL.

Best practices

  • Keep descriptions concise and focused on group rules or resources.

  • Update the description when project milestones change.

  • Use emojis to make key sections scanable.

The Semantic Manifesto: Defining Purpose through Persistent Context

In the landscape of distributed communities, the Set Description endpoint is your primary tool for Strategic Documentation. While the group subject identifies the conversation, the description defines its boundaries, its rules, and its technical interfaces. Because the group description is a persistent block of text that is accessible to all members at any time, it functions as a "Shared Source of Truth" or a "Group Handbook" that lives within the WhatsApp interface itself. By programmatically managing this field, you move beyond the era of ephemeral chatting and into the era of Governance-First Collaborative Workspaces.

For architects and product managers, the group description is the Contextual Foundation upon which professional interactions are built. This guide explores the strategic imperatives of managing group manifestos at scale.

🏗️ Architectural Philosophy: The Persistent Context Layer

From a technical perspective, the group description is a Large-Scale Metadata Buffer that is synchronized globally.

Key Architectural Objectives:

  • Static Resource Discovery: Users often forget the specific links or command prefixes required to interact with your business bots. By embedding this information in the group description, you provide a "Lasting Reference" that doesn't disappear when the chat history is cleared or when new messages arrive. It is the only part of the group state that remains "Pinned" to the top of the group info screen.
  • The Power of Admin Authority: Like the subject, the ability to change the description is a privileged act. In professional environments, you should almost always set your group Settings to "Admins Only" for metadata changes. This prevents participants from overwriting your official business SOPs or support links with their own text.
  • Zero-Latency Propagation: When your API updates the description, the change is reflected immediately for all participants. Meta's infrastructure handles the complex heavy lifting of ensuring that a user in Tokyo and a user in London see the same "Manifesto" simultaneously, providing a unified global context.

🚀 Strategic Use Cases: The Command Center and Onboarding Handbook

The group description should be treated as a dynamic asset that evolves during the project lifecycle.

1. The Interactive "Bot Command Desk"

If your WhatsApp group is integrated with an AI agent or a workflow engine (e.g., a group for a field service team), use the description to host a Documentation of Capabilities. List the specific keywords that trigger actions, such as:

  • /status - Fetch the current project milestone.
  • /upload - Get a link to the secure document portal.
  • /escalate - Notify a senior manager. By hosting this "Cheat Sheet" in the description, you empower participants to interact with your automation without needing to read a separate 20nd-page PDF manual.

2. The Dynamic Onboarding & KYC Handbook

For financial or medical groups, the first interaction is often the most critical. When a group is created, your system should automatically populate the description with Legal Disclaimers, Privacy Links, and Resource Identifiers. As the user moves through the "KYC" (Know Your Customer) process, your system can update the description to reflect their current status (e.g., "Verification Pending - Please upload your ID via the link below"). This turns the group description into a progress tracker that provides constant reassurance to the user.

3. Hyperlink Hub for Managed Workflows

WhatsApp descriptions support clickable URLs. Use this to bridge the gap between the chat and your external business systems. Include links to:

  • Shared Google Drive folders for the project.
  • Specific Salesforce Case pages for the assigned agent.
  • Direct payment links for an outstanding invoice. By centralizing these links in the group description, you ensure they are never "Lost in the Scroll" of a busy conversation.

🔐 Administrative Mandate: Governance of the Group Handbook

In an enterprise setting, the group description is a branding asset. Consistency across hundreds of groups is essential for professional representation.

The "Standard Operating Procedure" Template

We recommend that your system uses a Templating Engine to generate group descriptions. A standard template might include:

  1. Mission Statement: A one-sentence summary of why the group exists.
  2. Stakeholder Directory: A list of the JIDs or names of the official business representatives in the room.
  3. Governance Policy: A brief note on expected behavior and response times (SLA).
  4. Resource Footer: Links to help centers or escalation paths.

Reconciliation and Integrity

If you allow humans (like field agents) to edit group descriptions, your system should still perform a "Compliance Audit." Listen for the group.update webhook. If a human agent changes the description and removes the mandatory "Legal Footer" or "Compliance Link," your system can automatically detect the missing required text and call the Set Description endpoint to restore the correct version, maintaining your organization's regulatory posture.

🛡️ Operational Best Practices: Formatting and Information Density

  • Brevity and Bullet Points: While WhatsApp descriptions can hold a significant amount of text, users will only read what they can quickly scan. Use emojis as bullet points and keep your paragraphs short.
  • The "Above the Fold" Rule: Only the first few lines of a description are visible in the main group info screen before the user has to tap "Read more." Put your most critical information (like the CASE ID or the URGENT ACTION LINK) at the very top.
  • Avoid Over-Updating: Every time you call this endpoint, a system message is generated in the chat. Limit updates to major state changes to avoid cluttering the conversational flow with administrative notices.

⚙️ Engineering Best Practices: The Validation Loop

  1. Check Metadata Permissions: Always verify that your Wawp instance is an admin before attempting to set the description. If the group is restricted and you aren't an admin, your call will fail with a 403.
  2. String Sanitization: Ensure that your description strings are correctly escaped and don't contain prohibited characters that could cause JSON parsing errors in your API calls.
  3. Synchronization with Source of Truth: When the description is updated via the API, your internal database should be updated simultaneously. This ensures that when an agent looks at your internal dashboard, they are seeing the exact same handbook that the customer sees in WhatsApp.

🎯 Conclusion: Mastering the Art of the Documented Community

The Set Description endpoint is the "Command Center" of your community architecture. It is your most powerful tool for establishing long-term context, providing resource discovery, and enforcing behavioral standards. By treating the group description as a living, programmable manifesto, you create a professional environment that is both efficient and highly governed. You move beyond "Simple Messaging" and into the world of Structured Collaborative Workspaces, where every participant has the information they need to succeed, right at their fingertips.

Request Parameters

Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.

Request Body

Sent as a JSON object
string

Your unique WhatsApp Instance ID

Example:
string

Your API Access Token

Example:
string

The unique ID of the group

Example:
string

New group description

Example:

Request Samples

Use these ready-to-go code snippets to integrate our API into your project quickly and efficiently. Choose your preferred language and library.

1const baseUrl = "https://api.wawp.net";
2const endpoint = "/v2/groups/1234567890@g.us/description";
3const params = new URLSearchParams({
4  "instance_id": "123456789",
5  "access_token": "123456789"
6}).toString();
7const body = {
8  "description": "This group is for discussing the new project features."
9};
10
11fetch(`${baseUrl}${endpoint}${params ? '?' + params : ''}`, {
12  method: "PUT",
13  headers: { "Content-Type": "application/json" },
14  body: JSON.stringify(body)
15})
16  .then(async (response) => {
17    if (response.ok) {
18      const data = await response.json();
19      console.log("Success:", data);
20      return data;
21    }
22    
23    // Error Handling
24    
25
26    const errorText = await response.text();
27    console.error(`Error ${response.status}: ${errorText}`);
28  })
29  .catch((error) => console.error("Network Error:", error));
Interactive Samples
Ln 29, Col 1javascript

Expected Responses

Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.

Description updated
application/json
boolean *

Example

{
"ok": true
}
Previous TopicDelete group picture
Next TopicUpdates the group subject

Command Palette

Search for a command to run...